home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
opus
/
ofu102.zip
/
README.OFU
< prev
Wrap
Text File
|
1993-03-30
|
8KB
|
194 lines
Opus Filename Updater for the Opus CBCS v1.7x/v1.8x Files Database
Copyright 1993 by Kevin Silcox
March 30, 1993
Disclaimer
----------
This software is available "AS IS". It is not guaranteed to work at
all. If it trashes your system or ruins your life, you have been warned.
I am not responsible for any damages incurred from the use or misuse of
this software. There is also no fee to use this software to keep with
the spirit of Opus.
***********************************************************
**** ALWAYS HAVE A RECENT BACKUP COPY OF YOUR DATABASE ****
***********************************************************
---===---
OFU allows you to automatically change filenames within the Opus
Files Database via a command-line interface. If OFU updates a filename
then the file information (date/time, size) will be updated to match
the new filename. This program should be very handy for those that do
automatic virus scanning of newly uploaded files, archive conversion,
or when converting archives to a different format.
OFU will automatically detect the version of files database you are
using and use the correct structures. Any structure changes made after
the date of this release may cause problems with the operation of OFU.
As of this release OFU works with Opus versions 1.7x, and the 1.99/1.8x
beta and gamma releases.
The files that OFU uses are the following:
(R-O) = Read-Only (R/W) = Read/Write
(R-O) PRM file To locate the system files if necessary
(R-O) FILESBBS.ADX To get valid area numbers and area
offsets within the database
(R-O) SYSFILE.DAT To get default download paths
(R/W) FILESBBS.DAT To read/update file information
The FILESBBS.DAT file is the only one that is ever changed, and is
opened in DENYWRITE share mode. If this is an incorrect method please
bring it to my attention. Thanks.
---===---
NOTICE: This program will abort if it detects that Opus is
currently active for the task it's processing. If the files database
is common between two or more tasks then you have to take the necessary
precautions to make sure OFU doesn't run while another task is active.
It is *highly* recommended that Opus is not active *at all* when running
OFU since the database will need to be re-indexed (OFARE) if any filenames
get changed. See Errorlevels below.
It may not be a requirement to run OFARE after changing a filename in
the database. I only recommend that since I've heard what can happen to
the user database if the NDX file isn't maintained. However, Opus has
displayed the correct information for a file area after the names have been
changed with OFU and OFARE has NOT been run.
The RAM requirement is based entirely on the buffer size, and the number
of areas being processed (along with the download path length). The base
memory required to load OFU is somewhere around 30Kb. Take the base value
and add the following values to get the approximate RAM requirement:
- Buffer size
- Number of areas times 30 bytes. Each area takes up 10 bytes plus the
length of the download path string (20 bytes is an approximation
for the download path string length).
So processing 50 areas with a 4Kb buffer would require somewhere around
35Kb. (50 * 30 + 4096 + 30720 = 36316 bytes or approximately 36Kb)
--=={*-------------------------------------------------*}==--
Errorlevels:
11: One or more filenames deleted/undeleted (run OFARE at your convenience)
10: One or more filenames changed (recommended to run OFARE immediately)
6: Error writing to file
5: Error reading file
4: Attempt to use potential invalid wildcard sequence
3: Current task active
2: Memory allocation error
1: Unsuccessful (General Error)
0: Nothing changed
------------------------------------------------------
Usage:
OFU oldName newName cmd [cmd] [...]
When changing filename(s).
or
OFU Name cmd [cmd] [...]
When using the Delete/Undelete option.
Valid Command-line Switches (cmd):
# A valid area number (i.e. 1 {not the # symbol}) for
processing.
/A Process all areas (self explanatory). All areas will be
searched for filename replacement.
/B# Multiply # by 2048 bytes (2Kb) for the memory buffer size.
This value will be used when allocating any buffer to read
data from a file (except the Area list which is determined
by the number of areas, and the size of the Download Path
strings). The default value is 2 which uses a buffer size
of 4Kb (and should give good performance). Valid values
are from 1 to 32.
/D[U] Delete/Undelete file(s) from database. The first filename
listed on the command-line will be the one marked for
deletion/undeletion from the specified file area(s). The
undelete is only useful if you just marked a file for deletion
(on accident?) and haven't re-indexed the database yet.
/Q Quiet mode. Suppresses filename display.
/R[Q][D][#] Using /R by itself will call OFARE if any filenames have
been changed. Adding a 'D' after it (no space) will also call
OFARE if a file has been marked as DELETED which will physically
remove the DELETED file. Specifying a number at the end of the
argument will pass that number as a buffer setting to OFARE.
------------------------------------------------------
Examples (and other information):
OFU *.ARC *.ZIP /A
OFU FILE1.ARC FILE1.ZIP 1 20
OFU NODELIST.A?? NODELIST.Z?? 12 /B1
OFU NODE*.A* *.Z* 6
OFU NODE*.A* *.Z* 6 /RQD20
OFU VIRUS.ZIP 1 /D
- Any valid DOS filename can be used, including the DOS wildcard
characters which should be processed the same way as DOS does.
- You can specify up to 64 areas to process on the command-line,
(if they'll fit) or OFU can process up to 4096 areas when using
the /A switch.
- Generally a small buffer size is best (especially when using /A),
unless you have exceptionally large file areas (over 200 files per
area). You shouldn't ever need to change the buffer size from the
default value, but the option is there just in case.
- Please be careful with wildcards! I've tried to screen out the more
dangerous combinations, but don't rely on my thinking of all possible
bad wildcard combinations. The safest thing to do is automatically
make a backup (or archive) of your database files once a day. That
way if something goes wrong you'll have a recent copy of the database.
If you discover a dangerous (one that makes OFU change filenames
incorrectly) wildcard combination that gets past OFU, please send me
Netmail as to the command-line and I'll try to add that combination
to the screening process. Thank you.
------------------------------------------------------
-={**}=-
Thank You for taking your time to read this, and use my program.
If you have any comments or suggestions, I'd like to hear from you.
Please contact me if you have any problems, or you would like to see
any added features. You may contact me (via NetMail) at the phone
number (or Net Addresses) listed below. I also read the NEWOPUS and
MEADOW Echo's. The latest version of my software is also available
on my BBS. It may be requested with the magic name of OFU.
--=={ Kevin Silcox ------
SysOp of:
StormFront
in Orangevale, California
(916) 988-0407
FidoNet (1:203/407.0)
CalNet (49:916/407.0)
BBS Hours:
24 hours a day,
excluding National Mail Hour:
1:00 a.m to 2:00 a.m PST
Special Thanks to my Beta Test Team and the Opus Utility Team.